Document run-env preview, recording, and replay - #458
Merged
Conversation
yuecideng
added
docs
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a dedicated Sphinx/MyST guide for embodichain run-env, documenting environment startup, interactive preview, recording options, and trajectory replay modes, and then links that guide from the existing documentation entry points.
Changes:
- Added a new
run-envguide describing rollout vs preview vs replay, recording outputs (dataset/video/trajectory), and kinematic/dynamic/control replay workflows. - Linked the new guide from the Guides index, CLI reference, and data-generation tutorial for discoverability.
- Updated the
literalincludemarker in the data-generation tutorial to match the currentrun_env.pyCLI signature.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/tutorial/data_generation.rst | Fixes literalinclude start marker for run_env.py and adds a pointer to the new guide. |
| docs/source/guides/run_env.md | New end-to-end run-env guide covering preview, recording outputs, and replay modes. |
| docs/source/guides/index.rst | Adds run_env to the Guides toctree so it’s included in navigation/build. |
| docs/source/guides/cli.md | Adds an explicit anchor for CLI cross-references and links to the detailed run_env guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a dedicated run-env guide covering environment startup, interactive preview, rollout recording, and trajectory replay. It distinguishes structured datasets, debug videos, and replay trajectories; documents the kinematic, dynamic, and control replay modes; and adds an end-to-end recommended workflow.
The guide is linked from the Guides index, CLI reference, and data-generation tutorial so users can find detailed behavior without expanding the CLI argument reference further. It also updates an outdated run_env.py literalinclude marker found during documentation validation.
Dependencies: None.
Related issue: None.
Type of change
Screenshots
Not applicable; this change adds reference documentation only.
Validation
Checklist